Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

List required development headers in README #3272

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

phlummox
Copy link

Intended to partially fix #3269.

The explanation of what these libraries are needed for still needs to be filled in.

Intended to partially fix universal-ctags#3269.

The explanation of what these libraries are needed for still needs to be filled in.
@codecov
Copy link

codecov bot commented Jan 16, 2022

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (39e2e3d) 85.21% compared to head (7848b3c) 85.21%.
Report is 1329 commits behind head on master.

Files Patch % Lines
parsers/openapi.c 91.66% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3272   +/-   ##
=======================================
  Coverage   85.21%   85.21%           
=======================================
  Files         210      210           
  Lines       49689    49689           
=======================================
  Hits        42343    42343           
  Misses       7346     7346           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@masatake
Copy link
Member

@phlummox, thank you.
I forgot that we have document writing about the optional packages in https://github.com/universal-ctags/ctags/blob/master/docs/autotools.rst. If you think the document is not enough, could you convert this pull request for the document?

At least, we must write about pcre2 in autotools.rst.
On Fedora, pcre2-devel is needed.

libxml2:
This allows Universal Ctags to work libxml2 based parsers like XSLT parser.

Jansson:
This allows Universal Ctags to emit tags in JSON format (--output-format=json option).
JSON parser works without Jansson.

LibYAML:
This allows Universal Ctags to work libYAML based parsers like OpenAPI parser.

pcre2:
This allows Universal Ctags to accept pcre2 regular expression when defining a parser from the command line. Currently, there is no built-i parser using pcre2.

All these are optional. Universal Ctags must be built without these libraries and their header files.

@masatake
Copy link
Member

libseccomp is also nice to have.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Build instructions seem incomplete - required/useful development headers not mentioned
2 participants